Adding first example to svMultiPhysics User Guide - #111
Conversation
|
@justran-csuf The CFD User Guide content should be placed under |
|
I think now that we are only supporting one solver, it makes sense to document how to run simulations with all the different physics one may want to use: CFD, EP, mechanics, etc. All of these will now be done with svMultiPhysics. Some of this content is already in the "SimCardio" section, so we should break that up and move the content to the relevant sections (for example there is quite a nice description there on how to run an EP simulation which needs to be updated). See the google slide I sent a while back with a possible outline. We could have a header on running simulations with svMultiPhycis, and in the main menu then list all the different physics options in an easy to find manner. |
|
@ktbolt Got it, I will move it to that folder. Should this content be in its own folder? Maybe |
|
@justran-csuf It should be in its own folder. We will rearrange content later on. |
justran-csuf
left a comment
There was a problem hiding this comment.
Added the second example to the CFD User Guide which covers unsteady simulations and RCR boundary conditions. I also moved all files into a "cfd" folder in the "user-guide" folder. I still kept an HTML file for staging purposes for me to check on the formatting, but will eventually delete this when this content is merged with the rest of the User Guide.
|
@justran-csuf I don't see your content. Do you see it in a local browser ? |
|
@justran-csuf I don't see the |
|
@ktbolt I added my CFD User Guide content to the main multi_physics.html. I also created a "svmp_user_guide_staging.hrml" file if you want to view the content separately. |
|
@justran-csuf You need to sync your fork with https://github.com/SimVascular/simvascular.github.io main branch. |
|
@justran-csuf Wait, I am not seeing the new menu organization using my local web browser. Do you see it ? |
|
@ktbolt I am not sure how to check the new menu organization. I only have been changing files in the "documentation" folder and created my own .html file for staging. I created my fork a while ago when we deleted the branches off the main repository. How often should I be syncing my fork? I have just been focused on getting the content finished. |
|
@justran-csuf You should update your fork after you see a PR here. Don't you use a local web server to see the changes that you've made ? @ryanspilker Can you see the new menu organization using caddy ? I do see it if I load the index.html file in Chrome. |
|
@ktbolt The problem appears to be that Justin’s feature branch is behind the repository’s @justran-csuf First make sure git remote -v
git fetch upstream
git switch main
git merge --ff-only upstream/main
git push origin main
git switch 100-creating-cfd-user-guide
git merge main
git push origin 100-creating-cfd-user-guideIf git remote add upstream https://github.com/SimVascular/simvascular.github.io.gitAfterward, preview the repository from its root, and open |
|
@ryanspilker My fork is synced but the web page still does not appear like the new organization when I use caddy. It looks fine when I load the index.html using Chrome so I guess I will use that. |
|
Thanks @ryanspilker for the instructions. I think I did everything correctly... When I use the Live Server extension in Visual Studio on the "index.html", I can see the new table of contents. Then when I navigate to the svMultiPhysics page, I see my new content as well. @ktbolt I have been using the Live Server extension in Visual Studio, but I was using it directly onto my staging file so I could view my content. I never tried using it on the index.html before now. |
Current situation
This pull request is the first example to be added to the CFD User Guide. It contains a worked example of setting up a steady rigid wall simulation in a patient-specific geometry of the descending aorta and iliac artery. It goes through the logical steps one would take to set up a CFD simulation along with the necessary commands in the svMultiPhysics .XML input file needed to execute these. Explanations are added to give context as to why certain decisions are made as well as to teach users the basics of CFD and cardiovascular modeling. Simulation results are also discussed briefly to show users what they should be looking for.
Release Notes
Documentation
Testing
Code of Conduct & Contributing Guidelines